Vcenter Lcm Deployment MigrationUpgrade Status UpgradeInfo

The Vcenter Lcm Deployment MigrationUpgrade Status UpgradeInfo schema contains properties to describe important parameters and state of the upgrade process.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "upgrade_to": "string",
    "start_switchover": "string",
    "pause": "string",
    "error": {},
    "remaining_replication_data": 0,
    "identifier": "string"
}

string

upgrade_to

Optional

Indicates to which version the upgrade is being executed or was executed.

This property was added in vSphere API 9.0.0.0.

If missing or null the upgrade process was not initialized.

string As date-time As date-time

start_switchover

Optional

Determines if the upgrade process will start the switchover at a specific time.

This property was added in vSphere API 9.0.0.0.

If missing or null the upgrade process will execute the switchover operation without a delay, once the replication is almost done and the upgrade can be executed with the least possible downtime.

string

pause

Optional

Determines if the upgrade process is set to pause at a specific point.

For more information see: Vcenter Lcm Deployment MigrationUpgrade PausePolicy.

This property was added in vSphere API 9.0.0.0.

If missing or null the upgrade is not configured to pause.

object

error

Optional

Description of the error that cause the upgrade to fail. In case of resume the error is removed. However, in case of cancel the error here is left for historical reasons only.

This property was added in vSphere API 9.0.0.0.

If missing or null the upgrade did not raise any errors.

integer As int64 As int64

remaining_replication_data

Required

The size of the data (in MB) that is left to be replicated from the source vCenter to the target vCenter.

This property was added in vSphere API 9.0.0.0.

string

identifier

Optional

A unique identifier assign to an upgrade run. New upgrade run will assign new ID.

This property was added in vSphere API 9.0.0.0.

If missing or null, there is no upgrade initialized on the vCenter.